Vendor sherlodoc #1259
Closed
Vendor sherlodoc #1259
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
WIP support of typedecl
Co-authored-by: panglesd <[email protected]>
Break www, so its disabled. Co-authored-by: panglesd <[email protected]>
Format for previous commit A bit of cleanup
Jsoo sherlodoc
add --version to sherlodoc (0.2)
package favouritism
tests link in docstrings Co-authored-by: Emile Trotignon <[email protected]>
remove weird warnings
The path relative to the project root makes sherlodoc impossible to vendor. Use a relative path instead.
"Fewer conversions between Names and strings"
"Overhaul of module-type-of and shadowing"
"Remove core types and exceptions from identifiers"
Several changes: - Entries are now defined in the `odoc_index` library, - Entries can have new kinds (pages, source, ...) - Indexes have the form of "skeletons of entries", that can be folded. - Indexes can be created by odoc with the `odoc compile-index` command, and then consumed by sherlodoc. These changes come from: - ocaml#1228 - ocaml#1232 - ocaml#1233 - ocaml#1244 - ocaml#1250 - ocaml#1251
This function was used only in sherlodoc, it makes sense to be here.
In particular, odoc 3 fixed a bug where "hidden" modules were still indexed. This is why e.g. `Base.StringLabels` is removed from the tests output.
Odoc 3 also fixed the way extension constructor are handled. Before, a "type" would be added, with ID the first constructor, making things rather strange from the user eg as in the (now fixed) example: ``` type Main.MyExtension ``` displayed for ``` type extensible_type += MyExtension ``` This is now fixed. A test for the definition of the extensible type is also added.
panglesd
reviewed
Dec 11, 2024
| @@ -23,3 +23,5 @@ | |||
| (progn | |||
| (bash "diff doc/driver.mld doc/driver.mld.corrected >&2 || true") | |||
| (cat doc/driver-benchmarks.json)))) | |||
|
|
|||
| (vendored_dirs vendor) | |||
There was a problem hiding this comment.
I don't think we want to consider sherlodoc as vendored: we want the tests to be run, the warnings to be displayed, ...
Merged
|
Closed in favor of #1263 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This vendors sherlodoc to simplify maintaining compatibility using a Git subtree. This is not a complicated concept, sherlodoc's code is simply copied into odoc's source tree and can be modified normally.
The commits made by the subtree command also point to sherlodoc's history. This allows to easily pull changes made to sherlodoc or to easily upstream change made in the vendored copy. Here are the commands I used to pull some unmerged PRs on sherlodoc:
git subtree pull -P vendor/sherlodoc/ --squash https://github.com/panglesd/sherlodoc odoc_3_compat_cleanto pull Odoc compatibility art-w/sherlodoc#46 into the vendored copy.git subtree pull -P vendor/sherlodoc/ --squash https://github.com/Julow/sherlodoc rel_blob_pathto pull Fix unvendorable [%blob] path art-w/sherlodoc#44This system might not work for ever and conflicts might be too hard to resolve for git subtree's algorithm. That's not a problem as this has no cost to begin with.
The last commit makes sherlodoc be part of the
odoc-driverpackage.